Class CustomUdpProcessImpl

All Implemented Interfaces:
IPCObject, CustomUdpProcess, Process

public class CustomUdpProcessImpl extends ProcessImpl implements CustomUdpProcess
Information provided by the PKI file:

    \class CustomUdpProcess
    
    \brief CustomUdpProcess is the process that manipulates the custom UDP process.
    
    \example network().getDevice("Router0").getProcess("UdpProcess").createCustomUdpProcess()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • start

      public boolean start(int port)
      Information provided by the PKI file:
      
          \brief Starts the custom UDP process on the specified port number.
          
          \param int, the port number.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      start in interface CustomUdpProcess
      Parameters:
      port - Takes in a parameter of port
      Returns:
      boolean Returns a boolean
    • stop

      public boolean stop()
      Information provided by the PKI file:
      
          \brief Stops the custom UDP process.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      stop in interface CustomUdpProcess
      Returns:
      boolean Returns a boolean
    • isStarted

      public boolean isStarted()
      Information provided by the PKI file:
      
          \brief Returns true if the custom UDP process was started, otherwise false.
          
          \return bool, true if the custom UDP process was started, otherwise false.
          
              
      Specified by:
      isStarted in interface CustomUdpProcess
      Returns:
      boolean Returns a boolean
    • getPortNumber

      public int getPortNumber()
      Information provided by the PKI file:
      
          \brief Returns the port number of this custom UDP process.
          
          \return int, the port number of this custom UDP process.
          
              
      Specified by:
      getPortNumber in interface CustomUdpProcess
      Returns:
      int Returns a int
    • createFrameInstance

      public FrameInstance createFrameInstance(int color, String dstStr)
      Information provided by the PKI file:
      
          \brief Creates a frame instance.
          
          \param color, the color for this frame instance.
          \param dstStr, the destination IP address for this frame instance.
          
          \return FrameInstance, a FrameInstance object.
          
              
      Specified by:
      createFrameInstance in interface CustomUdpProcess
      Parameters:
      color - Takes in a parameter of color
      dstStr - Takes in a parameter of dstStr
      Returns:
      FrameInstance Returns a FrameInstance